common.h File Reference

Common definitions: FiberEnd, etc. More...

Enumerations
enum	FiberEnd {   NOT_END = 0, PLUS_END = 1, MINUS_END = 2, NEAREST_END = 3,   ORIGIN = 7, CENTER = 8 }
	Designates the tip of a Fiber, but also the origin and center points. More...
enum	AssemblyState {   STATE_WHITE = 0, STATE_GREEN = 1, STATE_YELLOW = 2, STATE_ORANGE = 3,   STATE_RED = 4 }
	Possible dynamic states for the tip of a Fiber [dynamic instability]. More...
enum	Fate { FATE_DESTROY = 1, FATE_RESCUE = 2, FATE_NONE = 3 }
	Possible actions, when a Fiber becomes shorter that the allowed length. More...
enum	Confinement {   CONFINE_NOT = 0, CONFINE_INSIDE = 1, CONFINE_OUTSIDE = 2, CONFINE_SURFACE = 3,   CONFINE_ALL_INSIDE = 4, CONFINE_ALL_OUTSIDE = 5, CONFINE_PLUS_END = 10, CONFINE_MINUS_END = 11 }
	Possible modes of confinements. More...

Enumeration Type Documentation

enum AssemblyState

We prefer to not be too specific here about the nature of the different states, to allow the interpretation to be different in different types of Fiber.

Enumerator
STATE_WHITE	Used to indicate a non-dynamic end.
STATE_GREEN	First dynamic state: usually growing.
STATE_YELLOW	Intermediate dynamic state.
STATE_ORANGE	Intermediate dynamic state.
STATE_RED	Third dynamic state: usually shrinking.

enum Confinement

Enumerator
CONFINE_NOT	not confined
CONFINE_INSIDE	confine inside the Space
CONFINE_OUTSIDE	confine outside the Space
CONFINE_SURFACE	confine on the surface of the Space
CONFINE_ALL_INSIDE	confine the entire bead inside
CONFINE_ALL_OUTSIDE	confine the entire bead outside
CONFINE_PLUS_END	confine the PLUS_END of fibers to the surface of the Space
CONFINE_MINUS_END	confine the MINUS_END of fibers to the surface of the Space

enum Fate

Enumerator
FATE_DESTROY	the Fiber is destroyed: destroy
FATE_RESCUE	the Fiber is rescued: rescue
FATE_NONE	nothing is done: none

enum FiberEnd

Enumerator
NOT_END	not an end
PLUS_END	highest abscissa = last model-point
MINUS_END	lowest abscissa = fist model-point at index 0
NEAREST_END	used to designate the closest of the two ends
ORIGIN	refers to the origin of abscissa
CENTER	the mid-point between the two ends